home *** CD-ROM | disk | FTP | other *** search
/ iBrowse Update Disc / iBrowse Update Disc.iso / distrib / boot / !Boot / RO350Hook / Apps / !Squash / !Help < prev    next >
Text File  |  1994-05-19  |  4KB  |  100 lines
  1.                     !Squash
  2.                     =======
  3.  
  4. Squash is copyright © Acorn Computers, 1991.
  5.  
  6. !Squash is an application which compresses files using the RISC OS Squash
  7. module. The Squash module currently compresses using a 12-bit LZW
  8. algorithm but no guarantee is made that this will be so in the future.
  9.  
  10. To use !Squash simply double click on the !Squash icon in the relevant
  11. directory display. This will install !Squash on the icon bar where the
  12. !Squash icon should then appear.
  13.  
  14. Compressing a file
  15. ==================
  16.  
  17. To compress a file simply drag it to the !Squash icon on the icon bar.
  18. A save box will then be displayed which will contain the file name, a file
  19. icon and an OK button. The compressed file may be saved back to itself
  20. (ie. it will replace the original) by pressing return or clicking on OK
  21. without changing the file name. If the file name is changed or the file
  22. icon is dragged to a directory viewer then the original file will be left
  23. untouched.
  24.  
  25. Decompressing a file
  26. ====================
  27.  
  28. To decompress a file either double click on the compressed file or drag it
  29. to the !Squash icon on the icon bar. Double clicking on a compressed file
  30. will overwrite the compressed file with the decompressed file. Dragging to
  31. the icon bar allows the decompressed file to be saved elsewhere.
  32.  
  33. Compressing and decompressing files and directories
  34. ===================================================
  35.  
  36. To compress or decompress a directory just drag the directory to the !Squash
  37. icon on the icon bar. A save box will then be displayed which will contain
  38. the file name, a file icon, an OK button and two toggle buttons. The toggle
  39. buttons are used to specify whether the contents of the directory are to be
  40. compressed or decompressed, otherwise the procedure is the same as for
  41. compressing files.
  42.  
  43. Menu options
  44. ============ 
  45.  
  46. !Squash has one menu displayed by pressing Menu on the !Squash icon on the
  47. icon bar. This menu contains four options:
  48.  
  49. Info:        Displays some information about the version of !Squash which is
  50.              running.
  51.  
  52. Save Box:    Toggles the use of the save box.  The save box is switched on
  53.              initially which results in the manner of operation described
  54.              above.  Sometimes, if a large selection is made and dragged to
  55.              the squash icon for example, it may not be desirable to have a
  56.              save box for every file or directory selected.  This menu option
  57.              can be used to turn off the save box which means that all files
  58.              and directories will be replaced by their compressed versions.
  59.  
  60. Squash Apps: This is used to toggle the compressing of application 
  61.              directories. This is initially off ie. application directories 
  62.              which are found as a sub_directory of another directory are not              
  63.              compressed. Application directories which are explicitly dragged
  64.              to the !Squash icon will always be compressed.
  65.  
  66. Quit:        Terminates the !Squash application.
  67.  
  68. Squash utility program
  69. ======================
  70.  
  71. The !Squash directory also contains a utility called "Squash".  This utility
  72. can be copied to the Library directory and used on the command line to 
  73. compress files. The syntax is:
  74.  
  75. Squash <from-file> [<to-file>]
  76.  
  77. With a single file name the compressed or decompressed version of the file
  78. replaces the original.  With a second file name the result is written to the
  79. specified file.  Note that directories cannot be compressed using this
  80. utility.
  81.  
  82. With both !Squash and the command line utility, if an attempt is made to
  83. compress or decompress a zero length file or the result of a compression is
  84. larger than the original (this can happen for very small files) then the
  85. original file will simply be copied.  If the original file was to be
  86. replaced by the output then the original file is left untouched.
  87.  
  88. NB. Squash prepends a header to the compressed data.  This header is of the
  89. form:
  90.  
  91.            4-byte ID:       "SQSH"
  92.            1-word:          length of the original, uncompressed file
  93.            1-word:          load address of the original file
  94.            1-word:          execution address of the original file
  95.            1-word:          reserved (currently always 0)
  96.  
  97. Where the load and execution addresses are used to hold the file type and
  98. the date stamp of the original file.  These are restored when the file is
  99. decompressed.
  100.